abgroup.htmlHTMLudog3 πùΔ¢πùΔ¢ÅÅ\ Monkeybread Realbasic plugin - Documentation - ABGroup

MBS Plugin Documentation

This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.

This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.

The list of the themes Global methods by category Global methods by name The list of the classes The list of the controls

class ABGroup

class, Addressbook Di, 6. Aug 2002
Mac OS Classic: Does nothing. Mac OS Carbon: Works. Windows: Does nothing.
Function: A class for handling a group inside the addessbook.
Notes: Requires Mac OS X 10.2.

AddMember(member as ABPerson) as boolean

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Adds a person to the group.
Notes: Requires Mac OS X 10.2.

AddSubGroup(group as ABGroup) as boolean

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Returns an array with all groups which belong to this group.
Notes: Requires Mac OS X 10.2.

AllMembers as ABPersonArray

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Returns an array with all persons who belong to this group.
Notes: Requires Mac OS X 10.2.

GetDistributionIdentifier(person as ABPerson,property as CFString) as CFString

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns the distribution identifier.
Notes: Requires Mac OS X 10.2.

GetValue(property as CFString) as CFObject

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a value from this person.
Notes:
Returns nil if value not found or not set.
Requires Mac OS X 10.2.

MatchSearch(search as ABSearch) as boolean

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Does this person match the search object?
Notes: Requires Mac OS X 10.2.

ParentGroups as ABGroupArray

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Returns an array with all groups where this group belongs to.
Notes: Requires Mac OS X 10.2.

RemoveMember(member as ABPerson) as boolean

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Removes a person to the group.
Notes: Requires Mac OS X 10.2.

RemoveSubGroup(group as ABGroup) as boolean

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Removes the sub group from this group.
Notes: Requires Mac OS X 10.2.

RemoveValue(property as CFString) as boolean

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Removes a value.
Notes:
Returns false if value not found or not set. True if successfull.
Requires Mac OS X 10.2.

SetDistributionIdentifier(person as ABPerson,property as CFString,identifier as CFString) as boolean

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Sets the distribution identifier.
Notes:
Returns true if successfull.
Requires Mac OS X 10.2.

SetValue(property as CFString,data as CFObject) as boolean

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: Sets a value.
Notes:
Returns false if value not found or not set.
Requires Mac OS X 10.2.

UniqueID as CFString

method, Addressbook Di, 6. Aug 2002
Mac OS Classic: -> false. Mac OS Carbon: Works. Windows: -> false.
Function: The Unique ID of this record.
Notes:
May be used to save a reference to a person inside a listbox (with an invisible column).
Requires Mac OS X 10.2.

Contact

Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.

This resource fork intentionally left blank ˇˇ